docs: clarify autoplay parameter availability in YouTubeEmbed #77485
+8
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
kimpuro
changed the title
Co-authored-by: Kief5555 <[email protected]>"
kimpuro
force-pushed
the
docs-youtube-embed
branch
from
1ca1b7f to
3ecd896
Compare
|
If these changes get merged, it would also address #77479 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improving Documentation
This PR updates the documentation for the YouTubeEmbed component to provide clearer information about parameter support.
What?
Updates the
paramsoption description in the YouTubeEmbed component documentation to clarify the availability of theautoplayparameter.Why?
The issue reported states that the Next.js documentation claims that YouTube IFrame API parameters can be used in
YoutubeEmbed, but theautoplayparameter does not work.The author of this issue initially thought that this behavior was due to the
YoutubeEmbedcomponent not having a built-in mute option. According to YouTube’s policy, videos that autoplay must start muted, but neither the YouTube IFrame API documentation nor theYoutubeEmbedcomponent mentions the mute option.However, even though
muteis not officially documented in the YouTube IFrame API, addingmute=1as a parameter does indeed work:Among these two implementations, only the
<iframe>version autoplays.The root cause lies in how
@next/third-partiesYoutubeEmbedinternally useslite-youtube-embedfor optimization.The reason
lite-youtube-embedis faster than a regular<iframe>is that it does not load the actual iframe on initial render.Since the iframe does not exist until the user clicks,
autoplaycannot work.As long as Next.js relies on
lite-youtube-embed, this issue will persist due to its performance optimization approach.However, because the Next.js documentation states that all YouTube IFrame API parameters are supported, this may mislead users.
In fact, the author of this issue initially thought this was a bug in Next.js.
How?
Added a clarification about the
autoplayparameter in theparamsoption description of the YouTubeEmbed component documentation.Fixes #77447